API endpoints

Ventilation units

The base URL for all paths is https://create-energy-label.service.gov.uk. No authentication is required for any endpoints.

Bidirectional ventilation units: arrow image

Path

/api/v1/ventilation-units/bidirectional-ventilation-units/arrow-image

Body schema

Send a POST request to the path above. The body of the request must be a JSON object with the following properties:

Property	Description	Type
productPriceHeightPx	Enter height of the product's price (in pixels). This may be up to 3 digits long.	Integer
labelOrientation	Arrow direction. Must be one of: LEFT RIGHT	String
labelFormat	Image format. Must be one of: JPEG PNG	String
efficiencyRating	The energy efficiency class indicator. Must be one of: A+ A B C D E F G	String

Example request body

{ "productPriceHeightPx": 100, "labelOrientation": "LEFT", "labelFormat": "JPEG", "efficiencyRating": "A+" }

Bidirectional ventilation units: energy label

You must display the label so that it’s easy to see and clearly related to the product. It must be at least 75mm x 150mm when printed.

Path

/api/v1/ventilation-units/bidirectional-ventilation-units/energy-label

Body schema

Send a POST request to the path above. The body of the request must be a JSON object with the following properties:

Property	Description	Type
outputFormat	Format of the generated label. Optional, defaults to PDF if not set. Must be one of: PDF PNG JPEG	String
supplierName	Supplier's name or trade mark.	String
modelName	Supplier's model identification code.	String
efficiencyRating	Energy efficiency indicator for an 'average' climate. Must be one of: A+ A B C D E F G	String
soundPowerLevel	Sound power level (LWA) in dB rounded to the nearest integer. This may be up to 2 digits long.	Integer
maxFlowRate	Maximum flow rate in m3/h rounded to the nearest integer. This may be up to 3 digits long.	Integer

Example request body

{ "outputFormat": "PDF", "supplierName": "example", "modelName": "example", "efficiencyRating": "A+", "soundPowerLevel": 1, "maxFlowRate": 1 }

Unidirectional ventilation units: arrow image

Path

/api/v1/ventilation-units/unidirectional-ventilation-units/arrow-image

Body schema

Send a POST request to the path above. The body of the request must be a JSON object with the following properties:

Property	Description	Type
productPriceHeightPx	Enter height of the product's price (in pixels). This may be up to 3 digits long.	Integer
labelOrientation	Arrow direction. Must be one of: LEFT RIGHT	String
labelFormat	Image format. Must be one of: JPEG PNG	String
efficiencyRating	The energy efficiency class indicator. Must be one of: A+ A B C D E F G	String

Example request body

{ "productPriceHeightPx": 100, "labelOrientation": "LEFT", "labelFormat": "JPEG", "efficiencyRating": "A+" }

Unidirectional ventilation units: energy label

You must display the label so that it’s easy to see and clearly related to the product. It must be at least 75mm x 150mm when printed.

Path

/api/v1/ventilation-units/unidirectional-ventilation-units/energy-label

Body schema

Send a POST request to the path above. The body of the request must be a JSON object with the following properties:

Property	Description	Type
outputFormat	Format of the generated label. Optional, defaults to PDF if not set. Must be one of: PDF PNG JPEG	String
supplierName	Supplier's name or trade mark.	String
modelName	Supplier's model identification code.	String
efficiencyRating	Energy efficiency indicator for an 'average' climate. Must be one of: A+ A B C D E F G	String
soundPowerLevel	Sound power level (LWA) in dB rounded to the nearest integer. This may be up to 2 digits long.	Integer
maxFlowRate	Maximum flow rate in m3/h rounded to the nearest integer. This may be up to 3 digits long.	Integer

Example request body

{ "outputFormat": "PDF", "supplierName": "example", "modelName": "example", "efficiencyRating": "A+", "soundPowerLevel": 1, "maxFlowRate": 1 }